<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: Functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__sysclk__clk__peripheral__group__funcs.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Functions<div class="ingroups"><a class="el" href="group__group__sysclk.html">SysClk       (System Clock)</a> &raquo; <a class="el" href="group__group__sysclk__clk__peripheral__group.html">Peripheral Group(MMIO Group) Controls</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga1dbf483034b8c7ae32fd3013cb013271"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__sysclk__returns.html#gad6699a184e2e3c01433251b0981558f3">cy_en_sysclk_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__peripheral__group__funcs.html#ga1dbf483034b8c7ae32fd3013cb013271">Cy_SysClk_PeriGroupSetDivider</a> (uint32_t groupNum, uint32_t divider)</td></tr>
<tr class="memdesc:ga1dbf483034b8c7ae32fd3013cb013271"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the divider value for a particular group.  <a href="#ga1dbf483034b8c7ae32fd3013cb013271">More...</a><br /></td></tr>
<tr class="separator:ga1dbf483034b8c7ae32fd3013cb013271"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga00f4d5d18fc8346aa1629acb172b5ae3"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__peripheral__group__funcs.html#ga00f4d5d18fc8346aa1629acb172b5ae3">Cy_SysClk_PeriGroupGetDivider</a> (uint32_t groupNum)</td></tr>
<tr class="memdesc:ga00f4d5d18fc8346aa1629acb172b5ae3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the divider value for a particular group.  <a href="#ga00f4d5d18fc8346aa1629acb172b5ae3">More...</a><br /></td></tr>
<tr class="separator:ga00f4d5d18fc8346aa1629acb172b5ae3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga237e467239332fcbba83e7b8c1dbfe8a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__sysclk__returns.html#gad6699a184e2e3c01433251b0981558f3">cy_en_sysclk_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__peripheral__group__funcs.html#ga237e467239332fcbba83e7b8c1dbfe8a">Cy_SysClk_PeriGroupSetSlaveCtl</a> (uint32_t groupNum, <a class="el" href="group__group__sysclk__clk__peripheral__group__enums.html#ga1bd5ef5e783689feeb68769207fc3756">cy_en_peri_grp_sl_ctl_num_t</a> slaveCtl, uint32_t value)</td></tr>
<tr class="memdesc:ga237e467239332fcbba83e7b8c1dbfe8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the particular Slave Control value for a particular group.  <a href="#ga237e467239332fcbba83e7b8c1dbfe8a">More...</a><br /></td></tr>
<tr class="separator:ga237e467239332fcbba83e7b8c1dbfe8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga99275f043f1a304bd579fc31783c2bd7"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__peripheral__group__funcs.html#ga99275f043f1a304bd579fc31783c2bd7">Cy_SysClk_PeriGroupGetSlaveCtl</a> (uint32_t groupNum, <a class="el" href="group__group__sysclk__clk__peripheral__group__enums.html#ga1bd5ef5e783689feeb68769207fc3756">cy_en_peri_grp_sl_ctl_num_t</a> slaveCtl)</td></tr>
<tr class="memdesc:ga99275f043f1a304bd579fc31783c2bd7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the particular Slave Control value for a particular group.  <a href="#ga99275f043f1a304bd579fc31783c2bd7">More...</a><br /></td></tr>
<tr class="separator:ga99275f043f1a304bd579fc31783c2bd7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga56bf76b1f4037514461e60a7428bf8a1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__peripheral__group__funcs.html#ga56bf76b1f4037514461e60a7428bf8a1">Cy_SysClk_IsPeriGroupSlaveCtlSet</a> (uint32_t groupNum, <a class="el" href="group__group__sysclk__clk__peripheral__group__enums.html#ga1bd5ef5e783689feeb68769207fc3756">cy_en_peri_grp_sl_ctl_num_t</a> slaveCtl, uint32_t slaveMsk)</td></tr>
<tr class="memdesc:ga56bf76b1f4037514461e60a7428bf8a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the mask value of particular slave control register for a particular group.  <a href="#ga56bf76b1f4037514461e60a7428bf8a1">More...</a><br /></td></tr>
<tr class="separator:ga56bf76b1f4037514461e60a7428bf8a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga1dbf483034b8c7ae32fd3013cb013271"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1dbf483034b8c7ae32fd3013cb013271">&#9670;&nbsp;</a></span>Cy_SysClk_PeriGroupSetDivider()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__sysclk__returns.html#gad6699a184e2e3c01433251b0981558f3">cy_en_sysclk_status_t</a> Cy_SysClk_PeriGroupSetDivider </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>groupNum</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>divider</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the divider value for a particular group. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__group__sysclk__returns.html#gad6699a184e2e3c01433251b0981558f3">cy_en_sysclk_status_t</a></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">groupNum</td><td>Selects the PERI Group Number </td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Input of groupNum parameter will be CAT1D devices - enum en_peri_grp_t(devices/COMPONENT_CAT1&lt;subcategory&gt; /include/&lt;series&gt;_config.h) CAT1B/CAT1C - group number</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">divider</td><td>Selects the divider value</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A (TVIIBE only), CAT1B, CAT1C and CAT1D devices.</dd>
<dd>
Clock divider functionality is product specific, Refer to TRM before using this API Example:- For CAT1B devices Group-0 does not have the clock divider functionality. For CAT1C devices Group-0,1 and 2 does not have the clock divider functionality. For the above not supported groups this API will return success, but write will not happen. </dd></dl>

</div>
</div>
<a id="ga00f4d5d18fc8346aa1629acb172b5ae3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga00f4d5d18fc8346aa1629acb172b5ae3">&#9670;&nbsp;</a></span>Cy_SysClk_PeriGroupGetDivider()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t Cy_SysClk_PeriGroupGetDivider </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>groupNum</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets the divider value for a particular group. </p>
<dl class="section return"><dt>Returns</dt><dd>Divider value</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">groupNum</td><td>Selects the PERI Group Number </td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Input of groupNum parameter will be CAT1D devices - enum en_peri_grp_t(devices/COMPONENT_CAT1&lt;subcategory&gt; /include/&lt;series&gt;_config.h) CAT1B/CAT1C - group number</dd>
<dd>
This API is available for CAT1A (TVIIBE only), CAT1B, CAT1C and CAT1D devices.</dd>
<dd>
Clock divider functionality is product specific, Refer to TRM before using this API Example:- For CAT1B devices Group-0 does not have the clock divider functionality. For CAT1C devices Group-0,1 and 2 does not have the clock divider functionality. For the above not supported groups this API returns zero. </dd></dl>

</div>
</div>
<a id="ga237e467239332fcbba83e7b8c1dbfe8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga237e467239332fcbba83e7b8c1dbfe8a">&#9670;&nbsp;</a></span>Cy_SysClk_PeriGroupSetSlaveCtl()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__sysclk__returns.html#gad6699a184e2e3c01433251b0981558f3">cy_en_sysclk_status_t</a> Cy_SysClk_PeriGroupSetSlaveCtl </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>groupNum</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__sysclk__clk__peripheral__group__enums.html#ga1bd5ef5e783689feeb68769207fc3756">cy_en_peri_grp_sl_ctl_num_t</a>&#160;</td>
          <td class="paramname"><em>slaveCtl</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the particular Slave Control value for a particular group. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__group__sysclk__returns.html#gad6699a184e2e3c01433251b0981558f3">cy_en_sysclk_status_t</a></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">groupNum</td><td>Selects the PERI Group Number </td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Input of groupNum parameter will be CAT1D devices - enum en_peri_grp_t(devices/COMPONENT_CAT1&lt;subcategory&gt; /include/&lt;series&gt;_config.h) CAT1B/CAT1C - group number</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">slaveCtl</td><td>Selects the Slave Control Register Number</td></tr>
    <tr><td class="paramname">value</td><td>Value to be written</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A (TVIIBE only), CAT1B, CAT1C and CAT1D devices. </dd></dl>

</div>
</div>
<a id="ga99275f043f1a304bd579fc31783c2bd7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga99275f043f1a304bd579fc31783c2bd7">&#9670;&nbsp;</a></span>Cy_SysClk_PeriGroupGetSlaveCtl()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t Cy_SysClk_PeriGroupGetSlaveCtl </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>groupNum</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__sysclk__clk__peripheral__group__enums.html#ga1bd5ef5e783689feeb68769207fc3756">cy_en_peri_grp_sl_ctl_num_t</a>&#160;</td>
          <td class="paramname"><em>slaveCtl</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets the particular Slave Control value for a particular group. </p>
<dl class="section return"><dt>Returns</dt><dd>Slave Control register value for a particular group</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">groupNum</td><td>Selects the PERI Group Number </td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Input of groupNum parameter will be CAT1D devices - enum en_peri_grp_t(devices/COMPONENT_CAT1&lt;subcategory&gt; /include/&lt;series&gt;_config.h) CAT1B/CAT1C - group number</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">slaveCtl</td><td>Selects the Slave Control Register Number</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A (TVIIBE only), CAT1B, CAT1C and CAT1D devices. </dd></dl>

</div>
</div>
<a id="ga56bf76b1f4037514461e60a7428bf8a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga56bf76b1f4037514461e60a7428bf8a1">&#9670;&nbsp;</a></span>Cy_SysClk_IsPeriGroupSlaveCtlSet()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Cy_SysClk_IsPeriGroupSlaveCtlSet </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>groupNum</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__sysclk__clk__peripheral__group__enums.html#ga1bd5ef5e783689feeb68769207fc3756">cy_en_peri_grp_sl_ctl_num_t</a>&#160;</td>
          <td class="paramname"><em>slaveCtl</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>slaveMsk</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets the mask value of particular slave control register for a particular group. </p>
<dl class="section return"><dt>Returns</dt><dd>Divider value</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">groupNum</td><td>Selects the PERI Group Number </td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Input of groupNum parameter will be CAT1D devices - enum en_peri_grp_t(devices/COMPONENT_CAT1&lt;subcategory&gt; /include/&lt;series&gt;_config.h) CAT1B/CAT1C - group number</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">slaveCtl</td><td>Selects the Slave Control Register Number</td></tr>
    <tr><td class="paramname">slaveMsk</td><td>Selects the bit position(s) that needs to be obtained</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A (TVIIBE only), CAT1B, CAT1C and CAT1D devices. </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
